

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Welcome to cup’s documentation! &mdash; cup 1.7.0 documentation</title>
  

  
  
  
  

  

  
  
    

  

  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="index" title="Index" href="genindex/" />
    <link rel="search" title="Search" href="search/" />
    <link rel="next" title="cup package" href="cup/" /> 

  
  <script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="#" class="icon icon-home"> cup
          

          
          </a>

          
            
            
              <div class="version">
                1.7
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search/" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="cup/">cup package</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="#">cup</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="#">Docs</a> &raquo;</li>
        
      <li>Welcome to cup’s documentation!</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="welcome-to-cup-s-documentation">
<h1>Welcome to cup’s documentation!<a class="headerlink" href="#welcome-to-cup-s-documentation" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="cup/">cup package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cup/#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cup.net/">cup.net package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="cup.net/#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="cup.net/#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="cup.net/#module-cup.net.route">cup.net.route module</a></li>
<li class="toctree-l4"><a class="reference internal" href="cup.net/#module-cup.net">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="cup.res/">cup.res package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="cup.res/#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="cup.res/#module-cup.res.linux">cup.res.linux module</a></li>
<li class="toctree-l4"><a class="reference internal" href="cup.res/#module-cup.res.mac">cup.res.mac module</a></li>
<li class="toctree-l4"><a class="reference internal" href="cup.res/#module-cup.res">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="cup.util/">cup.util package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="cup.util/#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="cup.util/#module-cup.util.conf">cup.util.conf module</a></li>
<li class="toctree-l4"><a class="reference internal" href="cup.util/#module-cup.util.constants">cup.util.constants module</a></li>
<li class="toctree-l4"><a class="reference internal" href="cup.util/#module-cup.util.context">cup.util.context module</a></li>
<li class="toctree-l4"><a class="reference internal" href="cup.util/#module-cup.util.misc">cup.util.misc module</a></li>
<li class="toctree-l4"><a class="reference internal" href="cup.util/#module-cup.util">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="cup.services/">cup.services package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="cup.services/#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="cup.services/#module-cup.services.autowait">cup.services.autowait module</a></li>
<li class="toctree-l4"><a class="reference internal" href="cup.services/#module-cup.services.buffers">cup.services.buffers module</a></li>
<li class="toctree-l4"><a class="reference internal" href="cup.services/#module-cup.services.executor">cup.services.executor module</a></li>
<li class="toctree-l4"><a class="reference internal" href="cup.services/#module-cup.services.generator">cup.services.generator module</a></li>
<li class="toctree-l4"><a class="reference internal" href="cup.services/#module-cup.services.heartbeat">cup.services.heartbeat module</a></li>
<li class="toctree-l4"><a class="reference internal" href="cup.services/#module-cup.services.msgbroker">cup.services.msgbroker module</a></li>
<li class="toctree-l4"><a class="reference internal" href="cup.services/#module-cup.services.serializer">cup.services.serializer module</a></li>
<li class="toctree-l4"><a class="reference internal" href="cup.services/#module-cup.services.threadpool">cup.services.threadpool module</a></li>
<li class="toctree-l4"><a class="reference internal" href="cup.services/#module-cup.services">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="cup.shell/">cup.shell package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="cup.shell/#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="cup.shell/#module-cup.shell.expect">cup.shell.expect module</a></li>
<li class="toctree-l4"><a class="reference internal" href="cup.shell/#module-cup.shell.oper">cup.shell.oper module</a></li>
<li class="toctree-l4"><a class="reference internal" href="cup.shell/#module-cup.shell">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="cup.storage/">cup.storage package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="cup.storage/#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="cup.storage/#module-cup.storage.obj">cup.storage.obj module</a></li>
<li class="toctree-l4"><a class="reference internal" href="cup.storage/#module-cup.storage">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="cup.jenkinslib/">cup.jenkinslib package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="cup.jenkinslib/#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="cup.jenkinslib/#module-cup.jenkinslib">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="cup.web/">cup.web package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="cup.web/#module-cup.web">Module contents</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cup/#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="cup/#module-cup.cache">cup.cache module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cup/#module-cup.const">cup.const module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cup/#module-cup.decorators">cup.decorators module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cup/#module-cup.err">cup.err module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cup/#module-cup.exfile">cup.exfile module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cup/#module-cup.flag">cup.flag module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cup/#module-cup.log">cup.log module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cup/#module-cup.mail">cup.mail module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cup/#module-cup.platforms">cup.platforms module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cup/#module-cup.thread">cup.thread module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cup/#module-cup.timeplus">cup.timeplus module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cup/#module-cup.unittest">cup.unittest module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cup/#module-cup.version">cup.version module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cup/#module-cup">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex/"><span class="std std-ref">Index</span></a></li>
<li><a class="reference internal" href="py-modindex/"><span class="std std-ref">Module Index</span></a></li>
<li><a class="reference internal" href="search/"><span class="std std-ref">Search Page</span></a></li>
</ul>
</div>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="cup/" class="btn btn-neutral float-right" title="cup package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2018, CUP-DEV.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'',
            VERSION:'1.7.0',
            LANGUAGE:'en',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'',
            HAS_SOURCE:  true,
            SOURCELINK_SUFFIX: '.txt'
        };
    </script>
      <script type="text/javascript" src="_static/jquery.js"></script>
      <script type="text/javascript" src="_static/underscore.js"></script>
      <script type="text/javascript" src="_static/doctools.js"></script>
      <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>

  

  <script type="text/javascript" src="_static/js/theme.js"></script>

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>